home *** CD-ROM | disk | FTP | other *** search
/ X User Tools / X User Tools (O'Reilly and Associates)(1994).ISO / sun4c / archive / tcltk.z / tcltk / man / cat3 / GetJoinStl.3 < prev    next >
Text File  |  1994-09-20  |  3KB  |  133 lines
  1.  
  2.  
  3.  
  4. Tk_GetJoinStyle(3)    Tk Library Procedures
  5.  
  6.  
  7.  
  8. _________________________________________________________________
  9.  
  10. NAME
  11.      Tk_GetJoinStyle,  Tk_NameOfJoinStyle  -  translate   between
  12.      strings and join styles
  13.  
  14. SYNOPSIS
  15.      #include <tk.h>
  16.  
  17.      int
  18.      Tk_GetJoinStyle(_i_n_t_e_r_p, _s_t_r_i_n_g, _j_o_i_n_P_t_r)
  19.  
  20.      char *
  21.      Tk_NameOfJoinStyle(_j_o_i_n)
  22.  
  23. ARGUMENTS
  24.      Tcl_Interp   *_i_n_t_e_r_p    (in)      Interpreter  to  use   for
  25.                                        error reporting.
  26.  
  27.      char         *_s_t_r_i_n_g    (in)      String containing name  of
  28.                                        join    style:    one   of
  29.                                        ``bevel'',  ``miter'',  or
  30.                                        ``round''.
  31.  
  32.      int          *_j_o_i_n_P_t_r   (out)     Pointer  to  location   in
  33.                                        which   to  store  X  join
  34.                                        style   corresponding   to
  35.                                        _s_t_r_i_n_g.
  36.  
  37.      int          _j_o_i_n       (in)      Join style: one  of  Join-
  38.                                        Bevel,   JoinMiter,  Join-
  39.                                        Round.
  40. _________________________________________________________________
  41.  
  42.  
  43. DESCRIPTION
  44.      Tk_GetJoinStyle  places  in  *_j_o_i_n_P_t_r  the  X   join   style
  45.      corresponding  to  _s_t_r_i_n_g,  which  will be one of JoinBevel,
  46.      JoinMiter, or JoinRound.  Join styles are typically used  in
  47.      X  graphics  contexts to indicate how adjacent line segments
  48.      should be joined together.   See  the  X  documentation  for
  49.      information on what each style implies.
  50.  
  51.      Under normal circumstances the return value  is  TCL_OK  and
  52.      _i_n_t_e_r_p  is  unused.   If _s_t_r_i_n_g doesn't contain a valid join
  53.      style or an abbreviation of one  of  these  names,  then  an
  54.      error  message  is  stored  in  _i_n_t_e_r_p->_r_e_s_u_l_t, TCL_ERROR is
  55.      returned, and *_j_o_i_n_P_t_r is unmodified.
  56.  
  57.      Tk_NameOfJoinStyle    is    the    logical    inverse     of
  58.      Tk_GetJoinStyle.   Given  a  join style such as JoinBevel it
  59.      returns a statically-allocated string corresponding to _j_o_i_n.
  60.  
  61.  
  62.  
  63. Tk                                                              1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. Tk_GetJoinStyle(3)    Tk Library Procedures
  71.  
  72.  
  73.  
  74.      If  _j_o_i_n  isn't  a  legal  join  style,  then ``unknown join
  75.      style'' is returned.
  76.  
  77.  
  78. KEYWORDS
  79.      bevel, join style, miter, round
  80.  
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129. Tk                                                              2
  130.  
  131.  
  132.  
  133.